Refactor _getEtag to get etag from gzip instead of buffer#270
Merged
mathieucarbou merged 2 commits intoAug 21, 2025
Merged
Conversation
This PR updates the _getEtag implementation in AsyncWebServerRequest to improve how ETags are generated. Previously, the method relied on a 4-byte trailer buffer passed as a parameter. This has been replaced with a more robust approach: the function now reads the CRC directly from the last 8 bytes of the gzip file. This ensures that the ETag is derived from the actual file contents rather than depending on an external buffer. Key changes: _getEtag now accepts a File handle instead of a trailer array. The method seeks to the gzip footer (size - 8) and extracts the CRC. Returns bool to indicate success/failure. ETag generation logic remains the same, ensuring backward compatibility for clients relying on ETags. This change improves correctness, reduces external dependencies, and makes ETag generation more consistent with the gzip specification.
Author
|
This is the same change as in PR #245. |
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the ETag generation mechanism for gzip-compressed files to improve correctness and robustness. Instead of relying on external trailer buffers, the system now reads the CRC32 checksum directly from the gzip file footer.
- Updated
_getEtagmethod to accept a File handle and return success/failure status - Modified AsyncFileResponse constructor to use the new ETag generation approach
- Streamlined file opening logic by removing unnecessary else block
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/ESPAsyncWebServer.h | Updated _getEtag method signature to accept File handle and return bool |
| src/AsyncWebServerRequest.cpp | Implemented new ETag generation logic that reads CRC from gzip footer |
| src/WebResponses.cpp | Updated AsyncFileResponse constructor to use new ETag method and simplified file opening logic |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
mathieucarbou
requested changes
Aug 21, 2025
mathieucarbou
approved these changes
Aug 21, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates the _getEtag implementation in AsyncWebServerRequest to improve how ETags are generated.
Previously, the method relied on a 4-byte trailer buffer passed as a parameter. This has been replaced with a more robust approach: the function now reads the CRC directly from the last 8 bytes of the gzip file. This ensures that the ETag is derived from the actual file contents rather than depending on an external buffer.
Key changes:
_getEtag now accepts a File handle instead of a trailer array.
The method seeks to the gzip footer (size - 8) and extracts the CRC.
Returns bool to indicate success/failure.
ETag generation logic remains the same, ensuring backward compatibility for clients relying on ETags.
This change improves correctness, reduces external dependencies, and makes ETag generation more consistent with the gzip specification.